home *** CD-ROM | disk | FTP | other *** search
/ The Fatted Calf / The Fatted Calf.iso / Applications / Graphics / GraphicsWorkshop / Source / Converters / pcx.h < prev    next >
Encoding:
Text File  |  1993-01-14  |  7.7 KB  |  184 lines
  1. /*
  2.  * This is perhaps one of the most important objects. It's what deals with reading and
  3.  * writing the bitmaps to and from disk. When used init and free should always be called.
  4.  * The concept of sender is used in a couple of places in this object and should respond to
  5.  * the following request: It should respond to getImageCon and return the id of a ImageControl 
  6.  * object. Note that the NXBitmapImageRep links this from disk at run time. You may also
  7.  * do this, should you wish, or you may define your own set of internal routines. Whatever
  8.  * you do, the ImageControl object should respond to everything defined in image.h, and
  9.  * these should have predictable results.
  10.  */
  11.  
  12. #import <objc/Object.h>
  13. #import "Converter.h"
  14.  
  15. @interface PCX : Converter
  16. {
  17. }
  18.  
  19. /*
  20.  * Initializes the object. This need not necessarily be used, but you can use it if you'd like.
  21.  * Assumes:     Nothing
  22.  * Returns:    self
  23.  * Results:    A new object is up and running.
  24.  */
  25. - init;
  26.  
  27. /*
  28.  * Frees anything used by the object.
  29.  * Assumes:    Object is instantiated.
  30.  * Results:     It is no longer valid to message the object.
  31.  */
  32. - free;
  33.  
  34. /*
  35.  * Reads the bitmap from stream. 
  36.  * Assumes:    The object has been instantiates, stream is an valid stream opened for at least
  37.  *            reading. Sender is the id of whatever object is calling the converter. 
  38.  * Returns:    id of an NXBitmapImageRep or nil if the image was unable to be read.
  39.  */
  40. - readFromStream: (NXStream *)stream from: sender;
  41.  
  42. /*
  43.  * Write the bitmaps id to stream.
  44.  * Assumes:    Object has been instantiated. At times, it's best to have used a call to the
  45.  *             save panel first, since this can set internal variables, but it's not necessary.
  46.  *            stream should be a valid NXStream opened for at least writing. Sender should
  47.  *            be the id of the caller. id is a NXBitmapImageRep, or something that responds
  48.  *            to all the message of the NXBitmapImageRep.
  49.  * Returns:    YES if the image was sucessfully writing, otherwise it returns NO.
  50.  */
  51. - (BOOL)write: (id)image toStream: (NXStream *)stream from: sender;
  52.  
  53. /*
  54.  * Similar to readFromStream but will read multiple images from a stream when present.
  55.  * Assumes:     Object instantiated. stream valid for reading. sender is id of caller.
  56.  * Returns:    id of an NXImage or nil if unable to read the image. It should return a single
  57.  *            image in the least, even for formats that don't support multiple images.
  58.  */
  59. - readAllFromStream: (NXStream *)stream from: sender;
  60.  
  61. /*
  62.  * Reverses the process of read all.
  63.  * Assumes:     Object instantiates. id is to an NXImage or something that responds to all of
  64.  *            NXImage's methods. stream is valid for writing. This should always attempt
  65.  *            to write at least one image to disk (the first usually) even for formats that 
  66.  *            don't support multiple images.
  67.  * Returns:    YES if the image is sucessfully written to disk.
  68.  */
  69. - (BOOL)writeAll: (id)image toStream: (NXStream *)stream;
  70.  
  71. /*
  72.  * Creates and lays out a custom view that the converter can use to set customization
  73.  * parameters. 
  74.  * Assumes:     Object instantiated and the window server is running. width should be the
  75.  *            maximum width the custom view can be.
  76.  * Returns:    id of a parent view or nil if this object doesn't use one.
  77.  */
  78. - customSaveView: (int)width;
  79.  
  80. /*
  81.  * This is very similar to customSaveView, however, it is used to set parameters for
  82.  * the run time loading of images. This object does not support input custom views.
  83.  * Assumes:     Object instantiated and the window server is running. width should be the
  84.  *            maximum width the custom view can be.
  85.  * Returns:    id of a parent view or nil if this object doesn't use one.
  86.  */
  87. - customOpenView: (int)width;
  88.  
  89. /*
  90.  * Returns the name of the current format, ie, the gif converter returns the string "Graphics
  91.  * Interchange Format (GIF)".
  92.  * Assumes:     Object has been instantiated.
  93.  * Returns:    A pointer to a string. The caller should always use something like strcpy to
  94.  *            get a copy of the string, since it's life is only guaranteed for the life of the
  95.  *            object.
  96.  */
  97. - (char *)getFormatName;
  98.  
  99. /*
  100.  * This is a simple interface to setting custom values of various parameters. There are
  101.  * no standards for what a converter must take of these values, so while the converter
  102.  * will tell you whether it took the value you or not, you, as the programmer, should
  103.  * not get upset when a parameter is not taken. Likewise, should the converter receive
  104.  * a request to set a parameter it does not understand, it should always refuse it with
  105.  * grace (ie, make it idiot proof.) What parameters an indivudual converter will take
  106.  * should be documented somewhere with the converters distribution.
  107.  * Assumes:    The converter is instantiated, parameter is a NULL terminated character
  108.  *            string, and ptr is a pointer to the data type. This is determined by patameter.
  109.  * Returns:    YES if the value was set, NO if the setting failed for any reason.
  110.  */
  111.  - (BOOL)setCustomParameter: (const char *)parameter withValue: (void *)ptr;
  112.  
  113. /*
  114.  * Gets a custom parameter value. See above about support for this call, as it's similar
  115.  * to setCustomParameter. Mainly, the converter should not crash when a request for
  116.  * a non-existant parameter is made.
  117.  * Assumes:     The converter is instantiated and parameter is a NULL terminater char-
  118.  *            acter string.
  119.  * Returns:    A pointer to the parameter (type depends on return value) or nil if the
  120.  *            parameter is not understood.
  121.  */
  122.  - (void *)getCustomParameter: (const char *)parameter;
  123.  
  124.  /*
  125.   * Returns a string with copyright information, name of the author, where the author
  126.   * can be reached, etc. This should only be a couple of lines, so keep it short and 
  127.   * sweet. An example might be:
  128.   * "My Image Format Converter\nby Joe Programmer\nCopyright R'N'R Software\n ...
  129.   * ... email bugs to jprogramm@system.there.edu"
  130.   * Assumes:     Converter linked and instantiated.
  131.   * Returns:    A pointer to a null terminated string. This string must be non volatile for
  132.   *             the life of the converter. Ie, as long as the programmer keeps a converter
  133.   *            linked, the pointer should be valid.
  134.   */
  135.  - (char *)copyrightNotice;
  136.  
  137.  /*
  138.   * Returns the current error state of the converter.
  139.   * Assumes:     Converter has been instantiated.
  140.   * Returns:    0 = CONVERT_ERR_NONE         Signals no error
  141.   *            1 = CONVERT_ERR_WARNING   Signals action taken, but not one expected.
  142.   *            2 = CONVERT_ERR_FATAL          Signals no action taken.
  143.   */
  144.  - (int)errorState;
  145.  
  146.  /*
  147.   * Returns an int describing the current error message.
  148.   * Assumes:    Converter instantiated.
  149.   * Returns:    An int describing the error type. See defines for integers returned.
  150.   */
  151.  - (int)errorMessage;
  152.  
  153.  /*
  154.   * This provides support for non standard error messages. It's preferable for programmers
  155.   * to avoid this message, but in special cases where you need to express something unique,
  156.   * it is appropiate. Just remember, that the use of this message disables multilingual
  157.   * support.
  158.   * Assumes:    Converter Instantiated
  159.   * Returns:    NULL terminated string describing the error.
  160.   */
  161.  - (char *)errorStringMessage;
  162.  
  163.  /*
  164.   * This method returns YES if the converter requires the window server. Ideally, converters
  165.   * should not depend on the window server, but sometimes this cannot be avoided. For 
  166.   * example, a programmer wouldn't be expect to write a PostScript interpreter just to read
  167.   * in eps files. Note, however, that returning YES will result in the converter not working
  168.   * with command line versions of applications.
  169.   * Assumes:    Converter Instantiated
  170.   * Returns:    YES is window server is needed, NO otherwise.
  171.   */
  172. - (BOOL)needsWindowServer;
  173.  
  174. /*
  175.  * Returns a string in the form <major version>.<minor version>. This is used by 
  176.  * the calling program to see what level or protocol the object will respond to. 
  177.  * Assumes:    Converter instantiated.
  178.  * Returns:    A null terminated string in the form <major version>.<minor version>.
  179.  *            For example, 1.0.
  180.  */
  181. - (char *)protocolVersion;
  182.  
  183. @end
  184.